<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="ViewFrustum,com.derschmale.wick3d.core.frustum.ViewFrustum,bottom,far,farZ,left,matchNearPlaneToFocalLength,near,nearZ,right,top,containsPoint,update" name="keywords">
<title>com.derschmale.wick3d.core.frustum.ViewFrustum</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'ViewFrustum - Wick3d Documentation';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Wick3d Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?com/derschmale/wick3d/core/frustum/ViewFrustum.html&amp;com/derschmale/wick3d/core/frustum/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;ViewFrustum</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class ViewFrustum"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.derschmale.wick3d.core.frustum</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ViewFrustum</td>
</tr>
</table>
<p></p>
  The ViewFrustum class describes the volume of 3D space that is visible from a camera and a viewport. The visible space is enclosed by 6 planes, to which objects can be culled and/or clipped.
  If many objects are known to often be outside the visible area of the screen, it is suggested to define a ViewFrustum to a Camera3D and using a FrustumCuller in the pipeline. 
    <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../../cameras/Camera3D.html" target="">com.derschmale.wick3d.cameras.Camera3D</a>
<br>
<a href="../../view/Viewport.html" target="">com.derschmale.wick3d.view.Viewport</a>
<br>
<a href="../culling/FrustumCuller.html" target="">com.derschmale.wick3d.core.culling.FrustumCuller</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bottom">bottom</a> : <a href="../geometry/Plane.html">Plane</a>
<div class="summaryTableDescription">[read-only]
   The frustum's bottom plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#far">far</a> : <a href="../geometry/Plane.html">Plane</a>
<div class="summaryTableDescription">[read-only]
   The frustum's far plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#farZ">farZ</a> : Number<div class="summaryTableDescription">
   The distance of the far plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#left">left</a> : <a href="../geometry/Plane.html">Plane</a>
<div class="summaryTableDescription">[read-only]
   The frustum's left plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#matchNearPlaneToFocalLength">matchNearPlaneToFocalLength</a> : Boolean<div class="summaryTableDescription">
   Defines whether the near plane should be adjusted automatically according to the current projection's focal length.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#near">near</a> : <a href="../geometry/Plane.html">Plane</a>
<div class="summaryTableDescription">[read-only]
   The frustum's near plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#nearZ">nearZ</a> : Number<div class="summaryTableDescription">
   The distance of the near plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#right">right</a> : <a href="../geometry/Plane.html">Plane</a>
<div class="summaryTableDescription">[read-only]
   The frustum's right plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#top">top</a> : <a href="../geometry/Plane.html">Plane</a>
<div class="summaryTableDescription">[read-only]
   The frustum's top plane.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#ViewFrustum()">ViewFrustum</a>(nearZ:Number, farZ:Number)</div>
<div class="summaryTableDescription">
   Creates a ViewFrustum object.</div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#containsPoint()">containsPoint</a>(v:<a href="../math/Vector3D.html">Vector3D</a>):Boolean</div>
<div class="summaryTableDescription">
   Checks if a vector's coordinates are inside the ViewFrustum
   
   </div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#update()">update</a>(focalLength:Number, aspectRatio:Number):void</div>
<div class="summaryTableDescription">
   Updates the planes of the frustum
   
   </div>
</td><td class="summaryTableOwnerCol">ViewFrustum</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="bottom"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bottom</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>bottom:<a href="../geometry/Plane.html">Plane</a></code>&nbsp;&nbsp;[read-only]<p>
   The frustum's bottom plane.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get bottom():<a href="../geometry/Plane.html">Plane</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
</div>
</div>
<a name="far"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">far</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>far:<a href="../geometry/Plane.html">Plane</a></code>&nbsp;&nbsp;[read-only]<p>
   The frustum's far plane.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get far():<a href="../geometry/Plane.html">Plane</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
</div>
</div>
<a name="farZ"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">farZ</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>farZ:Number</code>&nbsp;&nbsp;[read-write]<p>
   The distance of the far plane. If culling or clipping is used with this frustum, it can be considered the drawing distance.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get farZ():Number</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set farZ(value:Number):void</code>
<br>
</div>
<a name="left"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">left</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>left:<a href="../geometry/Plane.html">Plane</a></code>&nbsp;&nbsp;[read-only]<p>
   The frustum's left plane.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get left():<a href="../geometry/Plane.html">Plane</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
</div>
</div>
<a name="matchNearPlaneToFocalLength"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">matchNearPlaneToFocalLength</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>matchNearPlaneToFocalLength:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Defines whether the near plane should be adjusted automatically according to the current projection's focal length. Default value is true.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get matchNearPlaneToFocalLength():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set matchNearPlaneToFocalLength(value:Boolean):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
<br>
<a href="../../projections/IProjection.html" target="">com.derschmale.wick3d.projections.IProjection</a>
</div>
</div>
<a name="near"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">near</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>near:<a href="../geometry/Plane.html">Plane</a></code>&nbsp;&nbsp;[read-only]<p>
   The frustum's near plane.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get near():<a href="../geometry/Plane.html">Plane</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
</div>
</div>
<a name="nearZ"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">nearZ</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>nearZ:Number</code>&nbsp;&nbsp;[read-write]<p>
   The distance of the near plane. Typically, if _matchNearPlaneToFocalLength is set to true, this is automatically set to the camera's focal length. Otherwise, changing this value has no effect.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get nearZ():Number</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set nearZ(value:Number):void</code>
<br>
</div>
<a name="right"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">right</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>right:<a href="../geometry/Plane.html">Plane</a></code>&nbsp;&nbsp;[read-only]<p>
   The frustum's right plane.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get right():<a href="../geometry/Plane.html">Plane</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
</div>
</div>
<a name="top"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">top</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>top:<a href="../geometry/Plane.html">Plane</a></code>&nbsp;&nbsp;[read-only]<p>
   The frustum's top plane.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get top():<a href="../geometry/Plane.html">Plane</a></code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../geometry/Plane.html" target="">com.derschmale.wick3d.core.geometry.Plane</a>
</div>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="ViewFrustum()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ViewFrustum</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function ViewFrustum(nearZ:Number, farZ:Number)</code><p>
   Creates a ViewFrustum object.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">nearZ</span>:Number</code> &mdash; The distance of the near plane. Typically, this is set to the camera's focal length.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">farZ</span>:Number</code> &mdash; The distance of the far plane. If culling or clipping is used with this frustum, it can be considered the drawing distance.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="containsPoint()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">containsPoint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function containsPoint(v:<a href="../math/Vector3D.html">Vector3D</a>):Boolean</code><p>
   Checks if a vector's coordinates are inside the ViewFrustum
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">v</span>:<a href="../math/Vector3D.html">Vector3D</a></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; A boolean value indicating whether or not the vector's coordinates are inside the frustum.
   
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../math/Vector3D.html" target="">com.derschmale.wick3d.core.math.Vector3D</a>
</div>
</div>
<a name="update()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">update</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function update(focalLength:Number, aspectRatio:Number):void</code><p>
   Updates the planes of the frustum
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">focalLength</span>:Number</code> &mdash; The focal length of the camera.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">aspectRatio</span>:Number</code> &mdash; The aspect ratio of the viewport
   
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../../cameras/Camera3D.html" target="">com.derschmale.wick3d.cameras.Camera3D</a>
<br>
<a href="../../view/Viewport.html" target="">com.derschmale.wick3d.view.Viewport</a>
</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
